Release 10.1A: OpenEdge Development:
AppBuilder

The event-mapping comment

This comment maps various AppBuilder events to XFTR event handlers. It is parsed by AppBuilder and must be the first comment after the &ANALYZE-SUSPEND directive. Figure C–5 provides an example, and illustrates the components of this comment type.

Figure C–5: Event handler components

Components 0 and 7 are standard comment delimiters. Component 1, which must end in a colon, is simply a title for the comment. Components 2 through 6 are space-delimited procedure names for the XFTR event handlers; each maps to a particular AppBuilder event, as follows:

Position 2 maps to the Realize event.
Position 3 maps to the Edit event.
Position 4 maps to the Destroy event.
Position 5 maps to the Read event.
Position 6 maps to the Write event.

For example, in Figure C–5, if an AppBuilder Realize event occurs, AppBuilder calls the adm2/support/_wizard.w event. Note that a question mark indicates that no event handler is specified for the corresponding event.

Table C–3 summarizes AppBuilder events that you can map to XFTR event handlers.

Table C–3: AppBuilder events 

AppBuilder event	Description	User actions
Realize	Occurs when a design window is realized.	Opening a procedure file, creating a new procedure file, changing layouts, or changing size of a window.
Edit	Occurs when AppBuilder presents an XFTR code block for editing.	Selecting an XFTR code section from the Section Editor’s List Sections dialog box.
Destroy	Occurs when a procedure file is closed, or when AppBuilder closes a design window.	Closing a design window.
Read	Occurs when AppBuilder has finished opening a procedure file.	Opening a procedure file.
Write	Occurs when AppBuilder generates code and saves it to a procedure file. Specifically, occurs when the XFTR is encountered at code generation.	Saving or running a design window.